﻿//-----------------------------------------------------------------------
// <copyright file="EntityChangedEventArgs.cs" company="Nathan Miller">
// Copyright (c) Nathan Miller.
//
// Permission is hereby granted, free of charge, to any person obtaining
// a copy of this software and associated documentation files (the
// "Software"), to deal in the Software without restriction, including
// without limitation the rights to use, copy, modify, merge, publish,
// distribute, sublicense, and/or sell copies of the Software, and to
// permit persons to whom the Software is furnished to do so, subject to
// the following conditions:
// 
// The above copyright notice and this permission notice shall be
// included in all copies or substantial portions of the Software.
// 
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
// EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
// MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
// NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
// LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
// OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
// WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
// </copyright>
//-----------------------------------------------------------------------
namespace TileTool.Scene.Entity
{
    using System;
    using TileTool.DataBag;

    /// <summary>
    /// Event args used when a scene entity edit event is triggered.
    /// </summary>
    public class EntityChangedEventArgs : EventArgs
    {
        #region Constructor

        /// <summary>
        /// Constructor for the edit event args.
        /// </summary>
        /// <param name="entity">Entity that changed.</param>
        /// <param name="value">Data bag value that changed. Can be null.</param>
        /// <param name="name">Name of the field that changed.</param>
        /// <param name="property">Property that changed if it is of the know base types.</param>
        public EntityChangedEventArgs(IEntity entity, IDataBagValue value, string name, EntityChangedProperty property)
        {
            this.Entity = entity;
            this.Value = value;
            this.PropertyName = string.IsNullOrEmpty(name) ? string.Empty : name;
            this.Property = property;
        }

        #endregion

        #region Properties - Public

        /// <summary>
        /// Gets the entity that changed.
        /// </summary>
        public IEntity Entity
        {
            get;
            private set;
        }

        /// <summary>
        /// Gets the databag value that changed if there was one. Can be null.
        /// </summary>
        public IDataBagValue Value
        {
            get;
            private set;
        }

        /// <summary>
        /// Gets the name of the property that changed.
        /// </summary>
        public string PropertyName
        {
            get;
            private set;
        }

        /// <summary>
        /// Gets the property that changed if it is of known type.
        /// </summary>
        public EntityChangedProperty Property
        {
            get;
            private set;
        }

        #endregion
    }
}
